\hypertarget{class_zebulon_1_1_underwater_1_1_report_motor_status1}{
\section{Zebulon::Underwater::ReportMotorStatus1 Class Reference}
\label{class_zebulon_1_1_underwater_1_1_report_motor_status1}\index{Zebulon::Underwater::ReportMotorStatus1@{Zebulon::Underwater::ReportMotorStatus1}}
}


Command message to set the desired thrust of a motor.  


{\ttfamily \#include $<$reportmotorstatus1.h$>$}Inheritance diagram for Zebulon::Underwater::ReportMotorStatus1::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2cm]{class_zebulon_1_1_underwater_1_1_report_motor_status1}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{class_zebulon_1_1_underwater_1_1_report_motor_status1_abf4c738f050dc72f4fc5f74c4749297c}{ReportMotorStatus1} ()
\begin{DoxyCompactList}\small\item\em Constructor. \item\end{DoxyCompactList}\item 
\hypertarget{class_zebulon_1_1_underwater_1_1_report_motor_status1_a1681b6dd01cd838a261dff17e78d8ede}{
virtual \hyperlink{class_zebulon_1_1_underwater_1_1_report_motor_status1_a1681b6dd01cd838a261dff17e78d8ede}{$\sim$ReportMotorStatus1} ()}
\label{class_zebulon_1_1_underwater_1_1_report_motor_status1_a1681b6dd01cd838a261dff17e78d8ede}

\begin{DoxyCompactList}\small\item\em Destructor. \item\end{DoxyCompactList}\item 
virtual int \hyperlink{class_zebulon_1_1_underwater_1_1_report_motor_status1_a84945630b1522121998605bb58041529}{WriteMessageBody} (CxUtils::Packet \&packet) const 
\begin{DoxyCompactList}\small\item\em Writes the contents of the message payload to the packet. \item\end{DoxyCompactList}\item 
virtual int \hyperlink{class_zebulon_1_1_underwater_1_1_report_motor_status1_ad1ee2367d8946e341243b6a95c3e60c8}{ReadMessageBody} (const CxUtils::Packet \&packet)
\begin{DoxyCompactList}\small\item\em Reads the contents of the message payload from the packet, and saves to internal data members. \item\end{DoxyCompactList}\item 
\hypertarget{class_zebulon_1_1_underwater_1_1_report_motor_status1_ab48c9ea7c1edc75556f00e434c3ec28e}{
virtual void {\bfseries Print} () const }
\label{class_zebulon_1_1_underwater_1_1_report_motor_status1_ab48c9ea7c1edc75556f00e434c3ec28e}

\item 
\hypertarget{class_zebulon_1_1_underwater_1_1_report_motor_status1_a8cdc4d283006f2bbb733066bec584a08}{
virtual Message $\ast$ \hyperlink{class_zebulon_1_1_underwater_1_1_report_motor_status1_a8cdc4d283006f2bbb733066bec584a08}{Clone} () const }
\label{class_zebulon_1_1_underwater_1_1_report_motor_status1_a8cdc4d283006f2bbb733066bec584a08}

\begin{DoxyCompactList}\small\item\em Makes a clone of the message. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item 
unsigned char \hyperlink{class_zebulon_1_1_underwater_1_1_report_motor_status1_a2a5c2fd04c3338aeba88671153463734}{mMotor}
\begin{DoxyCompactList}\small\item\em See seabotix interface design specification for decoding byte information. \item\end{DoxyCompactList}\item 
\hypertarget{class_zebulon_1_1_underwater_1_1_report_motor_status1_a73c99dd9f0878f61b3372e11ad44ec6f}{
unsigned char \hyperlink{class_zebulon_1_1_underwater_1_1_report_motor_status1_a73c99dd9f0878f61b3372e11ad44ec6f}{mStatus}}
\label{class_zebulon_1_1_underwater_1_1_report_motor_status1_a73c99dd9f0878f61b3372e11ad44ec6f}

\begin{DoxyCompactList}\small\item\em Indicates revision number of motor controller software. \item\end{DoxyCompactList}\item 
\hypertarget{class_zebulon_1_1_underwater_1_1_report_motor_status1_ab715d1b3cdba052a529b9f490dc73cad}{
unsigned char \hyperlink{class_zebulon_1_1_underwater_1_1_report_motor_status1_ab715d1b3cdba052a529b9f490dc73cad}{mFault}}
\label{class_zebulon_1_1_underwater_1_1_report_motor_status1_ab715d1b3cdba052a529b9f490dc73cad}

\begin{DoxyCompactList}\small\item\em Indicates fault status. \item\end{DoxyCompactList}\item 
\hypertarget{class_zebulon_1_1_underwater_1_1_report_motor_status1_a819cea365ed20bf4e3cd071a23d460ce}{
unsigned char \hyperlink{class_zebulon_1_1_underwater_1_1_report_motor_status1_a819cea365ed20bf4e3cd071a23d460ce}{mCurrent}}
\label{class_zebulon_1_1_underwater_1_1_report_motor_status1_a819cea365ed20bf4e3cd071a23d460ce}

\begin{DoxyCompactList}\small\item\em Indicates current being drawn by motor in tenths of amps. \item\end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
Command message to set the desired thrust of a motor. 

\subsection{Constructor \& Destructor Documentation}
\hypertarget{class_zebulon_1_1_underwater_1_1_report_motor_status1_abf4c738f050dc72f4fc5f74c4749297c}{
\index{Zebulon::Underwater::ReportMotorStatus1@{Zebulon::Underwater::ReportMotorStatus1}!ReportMotorStatus1@{ReportMotorStatus1}}
\index{ReportMotorStatus1@{ReportMotorStatus1}!Zebulon::Underwater::ReportMotorStatus1@{Zebulon::Underwater::ReportMotorStatus1}}
\subsubsection[{ReportMotorStatus1}]{\setlength{\rightskip}{0pt plus 5cm}ReportMotorStatus1::ReportMotorStatus1 ()}}
\label{class_zebulon_1_1_underwater_1_1_report_motor_status1_abf4c738f050dc72f4fc5f74c4749297c}


Constructor. 

$<$ Address of motor reporting status.

$<$ Indicates revision number of motor controller software.

$<$ Indicates fault status.

$<$ Indicates current being drawn by motor in tenths of amps. 

\subsection{Member Function Documentation}
\hypertarget{class_zebulon_1_1_underwater_1_1_report_motor_status1_ad1ee2367d8946e341243b6a95c3e60c8}{
\index{Zebulon::Underwater::ReportMotorStatus1@{Zebulon::Underwater::ReportMotorStatus1}!ReadMessageBody@{ReadMessageBody}}
\index{ReadMessageBody@{ReadMessageBody}!Zebulon::Underwater::ReportMotorStatus1@{Zebulon::Underwater::ReportMotorStatus1}}
\subsubsection[{ReadMessageBody}]{\setlength{\rightskip}{0pt plus 5cm}int ReportMotorStatus1::ReadMessageBody (const CxUtils::Packet \& {\em packet})\hspace{0.3cm}{\ttfamily  \mbox{[}virtual\mbox{]}}}}
\label{class_zebulon_1_1_underwater_1_1_report_motor_status1_ad1ee2367d8946e341243b6a95c3e60c8}


Reads the contents of the message payload from the packet, and saves to internal data members. 
\begin{DoxyParams}{Parameters}
\item[\mbox{$\leftarrow$} {\em packet}]Packet to read from.\end{DoxyParams}
\begin{DoxyReturn}{Returns}
4 on success, 0 on failure. 
\end{DoxyReturn}


Reimplemented from \hyperlink{class_zebulon_1_1_m_c_u_1_1_message}{Zebulon::MCU::Message}.\hypertarget{class_zebulon_1_1_underwater_1_1_report_motor_status1_a84945630b1522121998605bb58041529}{
\index{Zebulon::Underwater::ReportMotorStatus1@{Zebulon::Underwater::ReportMotorStatus1}!WriteMessageBody@{WriteMessageBody}}
\index{WriteMessageBody@{WriteMessageBody}!Zebulon::Underwater::ReportMotorStatus1@{Zebulon::Underwater::ReportMotorStatus1}}
\subsubsection[{WriteMessageBody}]{\setlength{\rightskip}{0pt plus 5cm}int ReportMotorStatus1::WriteMessageBody (CxUtils::Packet \& {\em packet}) const\hspace{0.3cm}{\ttfamily  \mbox{[}virtual\mbox{]}}}}
\label{class_zebulon_1_1_underwater_1_1_report_motor_status1_a84945630b1522121998605bb58041529}


Writes the contents of the message payload to the packet. 
\begin{DoxyParams}{Parameters}
\item[\mbox{$\leftarrow$} {\em packet}]Packet to write to.\end{DoxyParams}
\begin{DoxyReturn}{Returns}
4 on success, 0 on failure. 
\end{DoxyReturn}


Reimplemented from \hyperlink{class_zebulon_1_1_m_c_u_1_1_message}{Zebulon::MCU::Message}.

\subsection{Member Data Documentation}
\hypertarget{class_zebulon_1_1_underwater_1_1_report_motor_status1_a2a5c2fd04c3338aeba88671153463734}{
\index{Zebulon::Underwater::ReportMotorStatus1@{Zebulon::Underwater::ReportMotorStatus1}!mMotor@{mMotor}}
\index{mMotor@{mMotor}!Zebulon::Underwater::ReportMotorStatus1@{Zebulon::Underwater::ReportMotorStatus1}}
\subsubsection[{mMotor}]{\setlength{\rightskip}{0pt plus 5cm}unsigned char {\bf Zebulon::Underwater::ReportMotorStatus1::mMotor}}}
\label{class_zebulon_1_1_underwater_1_1_report_motor_status1_a2a5c2fd04c3338aeba88671153463734}


See seabotix interface design specification for decoding byte information. Address of motor reporting status. 

The documentation for this class was generated from the following files:\begin{DoxyCompactItemize}
\item 
C:/Users/Matt/Documents/School/Robotics/zebulon/v2/underwater/include/underwater/messages/\hyperlink{reportmotorstatus1_8h}{reportmotorstatus1.h}\item 
C:/Users/Matt/Documents/School/Robotics/zebulon/v2/underwater/src/underwater/messages/\hyperlink{reportmotorstatus1_8cpp}{reportmotorstatus1.cpp}\end{DoxyCompactItemize}
